版本：V4.0

设备管理API

获取设备列表

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
page_size	Integer	Body	是	每页数量
page_index	Integer	Body	是	当前页数

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
residence_id	String	Body	住宅ID
family_name	String	Body	家庭名称
residence_no	String	Body	住宅号码
building_id	String	Body	楼栋ID
building_name	String	Body	楼栋名称
device_id	String	Body	设备ID
device_name	String	Body	设备名称
mac	String	Body	MAC地址
connected_time	String	Body	连接时间，UTC
first_name	String	Body	名
last_name	String	Body	姓
online	Boolean	Body	判断设备在离线状态 true：在线 false：离线
sip	String	Body	SIP号
device_type	String	Body	判断设备类型 Multi-tenants Doorphone：梯口机 Single-tenant Doorphone：门口机 Indoor Monitor：室内机 Guard Phone：管理机 Access Control：门禁

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_device_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724802057424,
  "result": [
    {
      "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
      "device_name": "test",
      "mac": "C10519082089",
      "connected_time": "2024-01-26 04:59:20",
      "first_name": "Fly",
      "last_name": "Dom",
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "family_name": "test",
      "residence_no": "101",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01",
      "online": true,
      "sip": "123132312",
      "device_type": "Multi-tenants Doorphone"
    }
  ]
}

失败返回示例

见接口失败返回

获取设备信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
device_id	String	Body	是	设备ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
residence_id	String	Body	住宅ID
family_name	String	Body	家庭名称
residence_no	String	Body	住宅号码
building_id	String	Body	楼栋ID
building_name	String	Body	楼栋名称
device_name	String	Body	设备名称
mac	String	Body	MAC地址
connected_time	String	Body	连接时间，UTC
first_name	String	Body	名
last_name	String	Body	姓
online	Boolean	Body	判断设备在离线状态 true：在线 false：离线
sip	String	Body	SIP号
device_type	String	Body	判断设备类型 Multi-tenants Doorphone：梯口机 Single-tenant Doorphone：门口机 Indoor Monitor：室内机 Guard Phone：管理机 Access Control：门禁
allow_monitor	Boolean	Body	判断是否为允许监控 true：允许 false：不允许
is_public	Boolean	Body	判断是否为公共设备 true：是 false：否
relays	[]Object<relay>	Body	门控信息
security_relays	[]Object<relay>	Body	安全门控信息
firmware_version	String	Body	固件版本
hardware_version	String	Body	硬件版本
ip_address	String	Body	IP地址
subnet_mask	String	Body	子网掩码
gateway	String	Body	网关
primary_dns	String	Body	首选DNS
secondary_dns	String	Body	备选DNS
permission_buildings	[]Object<permission_building>	Body	授权楼栋信息

permission_building说明

参数名	类型	位置	说明
building_id	String	Body	楼栋ID
building_name	String	Body	楼栋名称

relay说明

参数名	类型	位置	说明
relay_name	String	Body	门控名称
relay_number	String	Body	门控拨号键值
relay_id	String	Body	门控ID
enable	Boolean	Body	判断是否启用门控 true：启用 false：禁用
access_control	Object<access_control>	Body	权限控制
show_home	Boolean	Body	判断是否展示家庭 true：展示 false：不展示
show_talking	Boolean	Body	判断是否展示通话 true：展示 false：不展示
schedule	Object<schedule>	Body	日程信息

access_control说明

参数名	类型	位置	说明
enable_pin	Boolean	Body	判断是否启用PIN码 true：启用 false：禁用
enable_rf_card	Boolean	Body	判断是否启用射频卡 true：启用 false：禁用
enable_face	Boolean	Body	判断是否启用人脸 true：启用 false：禁用
enable_ble	Boolean	Body	判断是否启用蓝牙 true：启用 false：禁用
enable_nfc	Boolean	Body	判断是否启用NFC true：启用 false：禁用

schedule说明

参数名	类型	位置	说明
enable	Boolean	Body	判断是否启用日程 true：启用 false：禁用
access	[]String	Body	权限

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_device_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "device_id": "d131adc223cc4b3bedb6bd4742dedcfa5",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724802105380,
  "result": {
    "device_name": "test",
    "mac": "C10519082089",
    "connected_time": "2024-01-26 04:59:20",
    "first_name": "Fly",
    "last_name": "Dom",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "family_name": "test",
    "residence_no": "101",
    "building_id": "b1a621c1ae77040d697bd2134700f57ee",
    "building_name": "AB01",
    "online": true,
    "sip": "123132312",
    "device_type": "Multi-tenants Doorphone",
    "allow_monitor": true,
    "is_public": true,
    "relays": [
      {
        "relay_name": "Front Door 3",
        "relay_number": "#",
        "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2",
        "enable": true,
        "access_control": {
          "enable_pin": true,
          "enable_rf_card": true,
          "enable_face": true,
          "enable_ble": true,
          "enable_nfc": true
        },
        "show_home": true,
        "show_talking": true,
        "schedule": {
          "enable": false,
          "access": []
        }
      }
    ],
    "security_relays": [],
    "firmware_version": "71.123.37.5",
    "hardware_version": "1.0",
    "ip_address": "192.168.18.171",
    "subnet_mask": "255.255.255.0",
    "gateway": "192.168.18.1",
    "primary_dns": "",
    "secondary_dns": "",
    "permission_buildings": [
      {
        "building_id": "bafa332e258aae1badbb27d31128f442d",
        "building_name": "001"
      }
    ]
  }
}

失败返回示例

见接口失败返回

更新设备信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
device_id	String	Body	是	设备ID
device_name	String	Body	是	设备名称
mac	String	Body	是	MAC地址
allow_monitor	Boolean	Body	是	判断是否为允许监控 true：允许 false：不允许
relays	[]Object<relay>	Body	否	门控信息
security_relays	[]Object<relay>	Body	否	安全门控信息

relay说明

参数名	类型	位置	必填	说明
relay_name	String	Body	是	门控名称
relay_number	String	Body	是	门控拨号键值
relay_id	String	Body	是	门控ID
enable	Boolean	Body	是	判断是否启用门控 true：启用 false：禁用
access_control	Object<access_control>	Body	是	权限控制
show_home	Boolean	Body	是	判断是否展示家庭 true：展示 false：不展示
show_talking	Boolean	Body	是	判断是否展示通话 true：展示 false：不展示
schedule	Object<schedule>	Body	是	日程信息

access_control说明

参数名	类型	位置	必填	说明
enable_pin	Boolean	Body	是	判断是否启用PIN码 true：启用 false：禁用
enable_rf_card	Boolean	Body	是	判断是否启用射频卡 true：启用 false：禁用
enable_face	Boolean	Body	是	判断是否启用人脸 true：启用 false：禁用
enable_ble	Boolean	Body	是	判断是否启用蓝牙 true：启用 false：禁用
enable_nfc	Boolean	Body	是	判断是否启用NFC true：启用 false：禁用

schedule说明

参数名	类型	位置	必填	说明
enable	Boolean	Body	是	判断是否启用日程 true：启用 false：禁用
access	[]String	Body	是	权限

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_device_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa22",
    "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
    "mac": "C10519082089",
    "device_name": "test",
    "allow_monitor": true,
    "relays": [
      {
        "relay_name": "Front Door 3",
        "relay_number": "#",
        "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2",
        "enable": true,
        "access_control": {
          "enable_pin": true,
          "enable_rf_card": true,
          "enable_face": true,
          "enable_ble": true,
          "enable_nfc": true
        },
        "show_home": true,
        "show_talking": true,
        "schedule": {
          "enable": false,
          "access": []
        }
      }
    ],
    "security_relays": []
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

获取通话历史记录

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
page_size	Integer	Body	是	每页数量
page_index	Integer	Body	是	当前页数
start_time	String	Body	是	开始时间，UTC
finish_time	String	Body	是	结束时间，UTC

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
caller_name	String	Body	通话方名称
callee_name	String	Body	接收方名称
call_time	String	Body	通话时间
call_duration	Integer	Body	通话时长，单位：秒

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_call_history",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "start_time": "2024-01-16 13:32:45",
    "finish_time": "2024-01-17 13:32:45",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

状态码：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "caller_name": "IT83_alq_180",
      "callee_name": "Jim",
      "call_time": "2024-01-16 17:32:43",
      "call_duration": 10
    }
  ]
}

失败返回示例

见接口失败返回

获取开门历史记录

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
page_size	Integer	Body	是	每页数量
page_index	Integer	Body	是	当前页数
start_time	String	Body	是	开始时间，UTC
finish_time	String	Body	是	结束时间，UTC

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
open_door	Boolean	Body	判断开门是否成功 true：成功 false：失败
account_name	String	Body	账号名称
device_name	String	Body	设备名称
capture_thumbnail_url	String	Body	抓拍缩略图地址
open_door_type	String	Body	开门类型
capture_picture_url	String	Body	抓拍图地址
open_door_time	String	Body	开门时间
residence_id	String	Body	住宅ID
family_name	String	Body	家庭名称
residence_no	String	Body	住宅号码
building_id	String	Body	楼栋ID
building_name	String	Body	楼栋名称

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_open_door_history",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "start_time": "2024-01-16 13:32:45",
    "finish_time": "2024-01-17 13:32:45",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

状态码：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "open_door": true,
      "account_name": "tom",
      "device_name": "R29",
      "capture_thumbnail_url": "https://test.akuvox.com/r.jpg",
      "open_door_type": "",
      "capture_picture_url": "https://test.akuvox.com/d.jpg",
      "open_door_time": "2024-01-16 15:25:45",
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "family_name": "test",
      "residence_no": "101",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01"
    }
  ]
}

失败返回示例

见接口失败返回

批量触发远程开门

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
devices	[]Object<device>	Body	是	设备信息

device说明

参数名	类型	位置	必填	说明
mac	String	Body	是	MAC地址
relay_id	String	Body	是	门控ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_trigger_remote_open_door",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "devices": [
      {
        "mac": "0C110508EF2E",
        "relay_id": "rr31adc223cc4b3bedb6bd4742dedcfa5"
      }
    ]
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

配置设备Autop

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
project_id	String	Body	是	项目ID
mac	String	Body	是	MAC地址
config	String	Body	是	配置

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "configure_device_autop",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": [
    {
      "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
      "mac": "0C110508EF2E",
      "config": "test"
    }
  ]
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

获取设备列表​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

获取设备信息​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

permission_building说明​

relay说明​

access_control说明​

schedule说明​

请求示例​

成功返回示例​

失败返回示例​

更新设备信息​

接口地址​

请求参数​

param说明​

relay说明​

access_control说明​

schedule说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

获取通话历史记录​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

获取开门历史记录​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

批量触发远程开门​

接口地址​

请求参数​

param说明​

device说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

配置设备Autop​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

获取设备列表

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

获取设备信息

接口地址

请求参数

param说明

返回参数

result说明

permission_building说明

relay说明

access_control说明

schedule说明

请求示例

成功返回示例

失败返回示例

更新设备信息

接口地址

请求参数

param说明

relay说明

access_control说明

schedule说明

返回参数

请求示例

成功返回示例

失败返回示例

获取通话历史记录

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

获取开门历史记录

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

批量触发远程开门

接口地址

请求参数

param说明

device说明

返回参数

请求示例

成功返回示例

失败返回示例

配置设备Autop

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例